/*
 * Copyright (c) 2004-2022, University of Oslo
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice, this
 * list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 * this list of conditions and the following disclaimer in the documentation
 * and/or other materials provided with the distribution.
 *
 * 3. Neither the name of the copyright holder nor the names of its contributors 
 * may be used to endorse or promote products derived from this software without
 * specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package org.hisp.dhis.report;

import static org.hisp.dhis.common.DxfNamespaces.DXF_2_0;

import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.databind.annotation.JsonSerialize;
import com.fasterxml.jackson.dataformat.xml.annotation.JacksonXmlProperty;
import com.fasterxml.jackson.dataformat.xml.annotation.JacksonXmlRootElement;
import java.util.ArrayList;
import java.util.List;
import org.hisp.dhis.common.BaseIdentifiableObject;
import org.hisp.dhis.common.MetadataObject;
import org.hisp.dhis.common.cache.CacheStrategy;
import org.hisp.dhis.common.cache.Cacheable;
import org.hisp.dhis.period.RelativePeriodEnum;
import org.hisp.dhis.period.RelativePeriods;
import org.hisp.dhis.schema.annotation.Gist;
import org.hisp.dhis.schema.annotation.Gist.Include;
import org.hisp.dhis.visualization.ReportingParams;
import org.hisp.dhis.visualization.Visualization;

/**
 * @author Lars Helge Overland
 */
@JacksonXmlRootElement(localName = "report", namespace = DXF_2_0)
public class Report extends BaseIdentifiableObject implements Cacheable, MetadataObject {
  private ReportType type;

  private String designContent;

  private Visualization visualization;

  private RelativePeriods relatives;

  private List<String> rawPeriods = new ArrayList<>();

  private ReportingParams reportingParams;

  private CacheStrategy cacheStrategy = CacheStrategy.RESPECT_SYSTEM_SETTING;

  // -------------------------------------------------------------------------
  // Constructors
  // -------------------------------------------------------------------------

  public Report() {}

  public Report(String name, ReportType type, String designContent, Visualization visualization) {
    this.name = name;
    this.type = type;
    this.designContent = designContent;
    this.visualization = visualization;
  }

  public Report(
      String name,
      ReportType type,
      String designContent,
      RelativePeriods relatives,
      ReportingParams reportingParams) {
    this.name = name;
    this.type = type;
    this.designContent = designContent;
    this.relatives = relatives;
    this.reportingParams = reportingParams;
  }

  // -------------------------------------------------------------------------
  // Logic
  // -------------------------------------------------------------------------

  public boolean isTypeReportTable() {
    return type != null && ReportType.JASPER_REPORT_TABLE.equals(type);
  }

  public boolean isTypeJdbc() {
    return type != null && ReportType.JASPER_JDBC.equals(type);
  }

  public boolean isTypeHtml() {
    return type != null && ReportType.HTML.equals(type);
  }

  public boolean hasVisualization() {
    return visualization != null;
  }

  /** Indicates whether this report has relative periods. */
  public boolean hasRelativePeriods() {
    return relatives != null && !relatives.isEmpty();
  }

  /** Indicates whether this report has specific report parameters set. */
  public boolean hasReportParams() {
    return reportingParams != null && reportingParams.isSet();
  }

  // -------------------------------------------------------------------------
  // Getters and setters
  // -------------------------------------------------------------------------

  @JsonProperty
  @JacksonXmlProperty(namespace = DXF_2_0)
  public ReportType getType() {
    return type;
  }

  public void setType(ReportType type) {
    this.type = type;
  }

  @JsonProperty
  @JacksonXmlProperty(namespace = DXF_2_0)
  public String getDesignContent() {
    return designContent;
  }

  public void setDesignContent(String designContent) {
    this.designContent = designContent;
  }

  @JsonProperty
  @JsonSerialize(as = BaseIdentifiableObject.class)
  @JacksonXmlProperty(namespace = DXF_2_0)
  public Visualization getVisualization() {
    return visualization;
  }

  public void setVisualization(Visualization visualization) {
    this.visualization = visualization;
  }

  @Gist(included = Include.FALSE)
  @JsonProperty("relativePeriods")
  @JacksonXmlProperty(namespace = DXF_2_0)
  public RelativePeriods getRelatives() {
    if (relatives == null) {
      List<RelativePeriodEnum> enums = new ArrayList<>();

      if (rawPeriods != null) {
        for (String relativePeriod : rawPeriods) {
          if (RelativePeriodEnum.contains(relativePeriod)) {
            enums.add(RelativePeriodEnum.valueOf(relativePeriod));
          }
        }
      }

      return new RelativePeriods().setRelativePeriodsFromEnums(enums);
    }

    return relatives;
  }

  /**
   * It overrides the rawPeriods with the relative periods provided. This is done for backward
   * compatibility reasons.
   *
   * @param relatives the {@link RelativePeriods}.
   */
  public void setRelatives(RelativePeriods relatives) {
    if (relatives != null) {
      List<RelativePeriodEnum> enums = relatives.getRelativePeriodEnums();

      for (RelativePeriodEnum periodEnum : enums) {
        String relativePeriod = periodEnum.name();

        if (RelativePeriodEnum.contains(relativePeriod)) {
          this.rawPeriods.add(relativePeriod);
        }
      }

      this.relatives = relatives;
    }
  }

  public List<String> getRawPeriods() {
    return rawPeriods;
  }

  public void setRawPeriods(List<String> rawPeriods) {
    this.rawPeriods = rawPeriods;
  }

  @JsonProperty
  @JacksonXmlProperty(namespace = DXF_2_0)
  public ReportingParams getReportParams() {
    return reportingParams;
  }

  public void setReportParams(ReportingParams reportingParams) {
    this.reportingParams = reportingParams;
  }

  @JsonProperty
  @JacksonXmlProperty(namespace = DXF_2_0)
  @Override
  public CacheStrategy getCacheStrategy() {
    return cacheStrategy;
  }

  public void setCacheStrategy(CacheStrategy cacheStrategy) {
    this.cacheStrategy = cacheStrategy;
  }
}
